package com.github.ghsea.scheduler.timer;

import java.util.Set;
import java.util.concurrent.TimeUnit;

/**
 * @author netty
 */
public interface Timer {

    /**
     * Schedules the specified {@link org.jboss.netty.util.TimerTask} for one-time execution after
     * the specified delay.
     *
     * @return a handle which is associated with the specified task
     *
     * @throws IllegalStateException if this timer has been
     *                               {@linkplain #stop() stopped} already
     */
    Timeout newTimeout(TimerTask task, long delay, TimeUnit unit);

    /**
     * Releases all resources acquired by this {@link org.jboss.netty.util.Timer} and cancels all
     * tasks which were scheduled but not executed yet.
     *
     * @return the handles associated with the tasks which were canceled by
     *         this method
     */
    Set<Timeout> stop();

    /**
     * added by guhai.
     * 获取timer状态。原生Netty里没有该方法。
     * @return
     */
    String getState();
}
